Enhance README with installation instructions and refactor aim query …#4
Conversation
…support loading in query.py to improve error handling for missing dependencies.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the project version to 0.2.0 and implements lazy loading for the aim package to improve error handling when the dependency is missing. It also adds installation instructions to the README and introduces integration tests for the new behavior. Review feedback suggests using uv tool install for global CLI installation, adding return type hints to the lazy loading utility, and fixing a version mismatch in the test assertions to prevent failures.
|
|
||
| ```bash | ||
| # Using uv (recommended) | ||
| uv add aimx |
There was a problem hiding this comment.
For a CLI tool like aimx, uv tool install is generally the recommended way to install it for global use, rather than uv add which is intended for project dependencies. Consider updating the recommendation to reflect this best practice.
| uv add aimx | |
| uv tool install aimx |
| error_message: str | None = None | ||
|
|
||
|
|
||
| def load_aim_query_support(): |
There was a problem hiding this comment.
Adding a return type hint to load_aim_query_support would improve code clarity and maintainability, consistent with the rest of the codebase which uses type hints for function signatures.
| def load_aim_query_support(): | |
| def load_aim_query_support() -> tuple[Any, Any]: |
|
|
||
| captured = capsys.readouterr() | ||
| assert exit_code == 0 | ||
| assert "aimx 0.1.0" in captured.out |
There was a problem hiding this comment.
The version string in this assertion is outdated. Since the project version was bumped to 0.2.0 in this pull request (see pyproject.toml and src/aimx/__init__.py), this test will fail unless updated to match the new version.
| assert "aimx 0.1.0" in captured.out | |
| assert "aimx 0.2.0" in captured.out |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 743eb6aebf
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| captured = capsys.readouterr() | ||
| assert exit_code == 0 | ||
| assert "aimx 0.1.0" in captured.out |
There was a problem hiding this comment.
This test hard-codes "aimx 0.1.0" even though the same commit bumps the project version to 0.2.0 (pyproject.toml and aimx.__version__), so the test will fail on every run immediately after this change. The check should derive the expected version dynamically (or match 0.2.0) so CI verifies the missing-aim behavior instead of failing due to stale version text.
Useful? React with 👍 / 👎.
1 participant
…support loading in query.py to improve error handling for missing dependencies.